DICE API Documentation/com.embabel.dice.governance

Package-level declarations

Types

data class DeclaredVersionDto(val schemaName: String, val contentHash: String, val entityTypeNames: List<String>, val relationshipNames: List<String>, val stamped: Boolean, val sweptVersionHash: String?)

What the application declares right now, and where that sits against what governance has recorded.

DriftCheckDto

data class DriftCheckDto(val schemaName: String, val versionHash: String, val contextId: String?, val capturedAt: String, val driftedEntityTypes: List<String>, val driftedRelationshipTypes: List<String>, val hasDrift: Boolean, val hasAnyChange: Boolean, val declaredDiff: MetamodelDiffDto?, val sweepImpact: MetamodelDiffDto)

Everything one drift check found, including the merged comparison a sweep would evaluate.

DriftReportDto

data class DriftReportDto(val schemaName: String, val versionHash: String, val contextId: String?, val capturedAt: String, val driftedEntityTypes: List<String>, val driftedRelationshipTypes: List<String>, val hasDrift: Boolean, val declaredDiff: MetamodelDiffDto?)

One drift check as it was written down.

GovernanceOperationsService

class GovernanceOperationsService(declaredSchemaSource: <Error class: unknown class>, versionStore: <Error class: unknown class>, driftReportStore: <Error class: unknown class>, driftCheckRunner: <Error class: unknown class>, driftSweep: DriftSweepCapable, propositions: PropositionStore)

The one place an operator reaches the schema governance loop: read what the last checks found, run a check, and let a quarantined proposition back into use.

GovernanceRequestException

class GovernanceRequestException(message: String) : RuntimeException

A request the operator surface refuses before it touches anything: a limit outside its bounds, a blank identifier, a timestamp that will not parse.

MetamodelDiffDto

data class MetamodelDiffDto(val fromVersionHash: String, val toVersionHash: String, val empty: Boolean, val addedEntityTypes: List<String>, val removedEntityTypes: List<String>, val modifiedEntityTypes: List<String>, val renamedEntityTypes: List<TypeRenameDto>, val changedProperties: List<PropertyChangeDto>, val addedRelationships: List<String>, val removedRelationships: List<String>)

A comparison of two declared schema versions, flattened to names an operator can read.

PropertyChangeDto

data class PropertyChangeDto(val typeName: String, val propertyName: String, val renamedTo: String?, val before: String, val after: String)

What a schema change did to one property.

ReleasedPropositionDto

data class ReleasedPropositionDto(val propositionId: String, val contextId: String, val status: String, val quarantined: Boolean, val quarantineReason: String?, val metadataRevised: String)

Where a proposition stands after a release: the state a caller gets back so it can see the hold is gone without a second read.

TypeRenameDto

data class TypeRenameDto(val before: String, val after: String)

An entity type that changed name.